rrweb docs

English

简体中文

English

简体中文

Get recording screenshot​

GET
/recordings/{recordingId}/screenshot

Generates a screenshot of a recording at a specific playback position. Supports extension-based negotiation via /recordings/{recordingId}/screenshot.png, .jpeg, or .webp; file extensions take precedence over the Accept header. This endpoint exposes only time, width, height, quality, and the negotiated output format from the underlying browser-rendering service.

Authorizations

Private API Key
Private API Key
Bearer token for authentication. Use your private API key as the token.
or
Presigned URL
Presigned URL
Use a presigned URL generated by the List Recordings endpoint with includeSignedUrls=true. Time-constrained and scoped to a single recording, so it can be exposed publicly in your replayer.
Show parameters: TenantId, KeyId, Expires, Signature
TenantId
Your tenant (organisation) identifier. Included automatically in presigned URLs generated by the listing endpoints.
KeyId
The name/label of the signing key configured in your rrweb Cloud account. e.g. "key-2024-12"
Expires
Expiration timestamp (UNIX seconds)
Signature
SHA256 over the constructed string "GET /recordings/{recordingId} {tenantId} {expires}". Please get in contact if you need to calculate this manually.

Parameters​

Path Parameters

recordingId*

The recording ID

Type
string
Required
Example"000e8400-e00b-00d0-a716-446655440000"
Format
"uuid"

Query Parameters

time

Playback position selector. Supports offset, percent, and epoch formats: offset:5000, offset:-5000, percent:50, or epoch:1702900000000. Defaults to offset:0.

Type
string
Example"offset:0"
width

Width in pixels from 1 to 4096. Defaults to 1280 when omitted. If height is provided and width is omitted, width is derived from the recording viewport ratio when metadata is available. Values outside this range return 400.

Type
string
Example"1280"
height

Height in pixels from 1 to 4096. Defaults to 720 when omitted and recording viewport metadata is unavailable. If width is provided or both dimensions are omitted, height is derived from the recording viewport ratio when metadata is available. Values outside this range return 400.

Type
string
Example"720"
quality

Quality from 1 to 100 for JPEG and WebP output (default: 80). Ignored for PNG.

Type
string
Example"80"

Responses​

Screenshot image

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI